Класс XML

Доступность

Flash Player 5 (является встроенным классом начиная с Flash Player 6, где его возможности были значительно расширены).

Описание

Используйте методы и свойства класса XML, чтобы загружать, анализировать(parse), отправлять, создавать динамически и изменять XML документы.

Прежде, чем станет возможным использовать методы и функции класса XML, необходимо воспользоваться конструктором new XML(), чтобы создать объект класса XML.

Документы XML представлены во Flash классом XML. Каждый элемент в иерархической структуре представлен объектом XMLNode.

Замечание: Объекты XML и XMLNode разработаны после выхода рекомендации W3C DOM Level 1: www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html. В этой рекомендации определены интерфейс узла (Node) и всего документа (Document). Интерфейс документа наследует у интерфейса узла и добавляет ряд собственных методов, например, createElement() и createTextNode(). В ActionScript объекты XML и XMLNode разработаны с целью разделения функциональности этих классов там, где они совпадают в рекомендации.

Обзор методов класса XML

Метод

Описание

XML.addRequestHeader()

Добавляет или изменяет HTTP заголовки (headers) для операций, производимых методом POST.

XML.appendChild()

Добавляет узел в конец списка потомков указанного узла.

XML.cloneNode()

Клонирует указанный узел и, возможно, рекурсивно клонирует все его дочерние узлы.

XML.createElement()

Создает новый XML элемент.

XML.createTextNode()

Создает новый текстовый XML узел.

XML.getBytesLoaded()

Возвращает число уже загруженных байт XML документа.

XML.getBytesTotal()

Возвращает полный размер XML документа в байтах.

XML.hasChildNodes()

Возвращает true, если указанный узел имеет потомков; в противном случае, возвращает false.

XML.insertBefore()

Добавляет узел в список дочерних узлов перед указанным.

XML.load()

Загружает документ (связываемый с XML объектом) с указанного URL.

XML.parseXML()

Анализирует XML документ и строит дерево XML объекта.

XML.removeNode()

Удаляет указанный узел из списка дочерних узлов его родителя.

XML.send()

Отправляет XML документ по указанному URL.

XML.sendAndLoad()

Отправляет XML документ по указанному URL и возвращает ответ сервера, как только он поступает, в виде другого XML документа.

XML.toString()

Преобразует указанный узел и все его дочерние узлы в текст.

Обзор свойств класса XML

Свойство

Описание

XML.contentType

MIME тип данных, передаваемых серверу.

XML.docTypeDecl

Устанавливает и возвращает информацию об объявлении DOCTYPE XML документа.

XML.firstChild

Только для чтения; ссылка на первый дочерний учел из списка указанного узла.

XML.ignoreWhite

Если равно true, то в процессе синтаксического разбора (парсинга, parsing) узлы, содержащие только пробелы, игнорируются.

XML.lastChild

Только для чтения; ссылается на последний дочерний узел.

XML.loaded

Только для чтения; проверяет, загружен ли указанный объект XML.

XML.nextSibling

Только для чтения; ссылается на следующий узел того же уровня (на следующий узел в списке дочерних узлов родительского узла).

XML.nodeName

Имя узла в объекте XML.

XML.nodeType

Тип указанного узла (элемент XML или текстовый узел).

XML.nodeValue

Текст указанного узла, если узел является текстовым.

XML.parentNode

Только для чтения; ссылается на родительский узел указанного узла.

XML.previousSibling

Только для чтения; ссылается на предыдущий узел того же уровня (на предыдущий узел в списке дочерних узлов родительского узла).

XML.status

Числовой код, определяющий удачно или неудачно прошел процесс синтаксического разбора (парсинга, parsing) XML документа.

XML.xmlDecl

Информация об XML объявлении документа.

Свойства-массивы класса XML

Свойство

Описание

XML.attributes

Returns an associative array that contains all the attributes of the specified node.

XML.childNodes

Только для чтения; returns an array that contains references to the child nodes of the specified node.

Обзор обработчиков событий класса XML

Обработчик

Описание

XML.onData

Invoked when XML text has been completely downloaded from the server, or when an error occurs downloading XML text from a server.

XML.onLoad

Returns a Boolean value indicating whether the XML object was successfully loaded with XML.load() or XML.sendAndLoad().

Конструктор класса XML

Доступность

Flash Player 5.

Синтаксис

new XML([source:String]) : XML

Параметры

source Строка; текст, который должен быть обработан анализатором (parsed) для получения нового объекта XML.

Возвращает

Ссылку на объект XML.

Описание

Конструктор; создает новый объект XML. Вы должны использовать конструктор, чтобы создать объект XML, прежде чем сможете воспользоваться свойствами и методами класса XML.

Замечание: Используйте методы createElement() и createTextNode() для добавления элементов и текстовых узлов в дерево XML документа.

Пример

В примере ниже создается новый пустой объект XML:

var my_xml:XML = new XML();

В примере ниже после обработки анализатором текста, переданного параметру source, создается объект XML, который содержит дерево получившегося в результате анализа документа:

var other_xml:XML = new XML("<state name=\"California\">
<city>San Francisco</city></state>");

См. также

XML.createElement(), XML.createTextNode()